Get All Events

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/events

Query Parameter

Table 1. Query parameter description

Parameter	Type	Description
keyword	string	Keyword of the event. For example, value change.
pageIndex	integer	Required. Page number. The default is 1.
pageSize	integer	Required. The number of data on each page. The default is 20 and the maximum is 500.
namespaces	array of strings	Namespace.
labelFullNames	array of strings	Label namespace.
excludeLabelFullNames	boolean	Whether to get data that is not bound with the specified label.
appNames	array of strings	App name.
excludeAppNames	boolean	Whether to get data that is not belong to the specified app.
instanceNames	array of strings	The instance alias list to which the metadata belongs. Its priority is higher than templateNames.
sourceFunctionSetFullNames	array of strings	List of source function set namespace.alias.
templateFullNames	array of strings	The template namespace.alias list to which the metadata belongs.
functionSetFullNames	array of strings	The function set namespace.alias list to which the metadata belongs.
containsInheritedMetadata	boolean	Whether to contain the inherited metadata. Matches with specified template or instance.
containsSelfMetadata	boolean	Whether to contain its own metadata. Matches with specified template or instance.

Request Body

Get events under the template system.t1 that have es in their names or aliases, and its source function set ID is system.f1 and is not bound with a label system.l1.

templateFullNames=system.t1&sourceFunctionSetFullNames=system.f1&
excludeLabelFullNames=true&labelFullNames=system.l1&keyword=es

Response

• 200: Successful.

  {
    "data": [
      {
        "id": 11139,
        "templateId": 11140,
        "instanceId": "11141",
        "functionSetId": 11142,
        "dataSetId": 11143,
        "dataSetDisplayName": "event data set of value change",
        "labelIds": [
          11144
        ],
        "appShowName": "system",
        "appName": "system",
        "namespace": "system",
        "sourceFunctionSetId": 11145,
        "displayName": "event1",
        "enName": "event1",
        "comment": "test data",
        "appAccessMode": "PUBLIC"
      }
    ],
    "pageIndex": 1,
    "pageSize": 20,
    "total": 20
  }
• 400: General internal error of OODM.

  {
    "code": 10001001,
    "data": {},
    "detail": "string",
    "message": "string"
  }